StartNew(TResult) Method (Func(Object, TResult), Object, CancellationToken)

Task Parallel System.Threading

previous page next page

Creates and starts a Task<(Of <(TResult>)>).

Namespace:  System.Threading.Tasks
Assembly:  System.Threading (in System.Threading.dll)

Syntax

Visual Basic (Declaration)
Public Function StartNew(Of TResult) ( _
	function As Func(Of Object, TResult), _
	state As Object, _
	cancellationToken As CancellationToken _
) As Task(Of TResult)
C#
public Task<TResult> StartNew<TResult>(
	Func<Object, TResult> function,
	Object state,
	CancellationToken cancellationToken
)

Parameters

function
Type: System..::.Func<(Of <(Object, TResult>)>)
A function delegate that returns the future result to be available through the Task<(Of <(TResult>)>).
state
Type: System..::.Object
An object containing data to be used by the function delegate.
cancellationToken
Type: System.Threading..::.CancellationToken
The CancellationToken that will be assigned to the new Task

Type Parameters

TResult
The type of the result available through the Task.

Return Value

The started Task<(Of <(TResult>)>).

Remarks

Calling StartNew is functionally equivalent to creating a Task<(Of <(TResult>)>) using one of its constructors and then calling Start to schedule it for execution. However, unless creation and scheduling must be separated, StartNew is the recommended approach for both simplicity and performance.

Exceptions

ExceptionCondition
System..::.ArgumentNullExceptionThe exception that is thrown when the function argument is null.
System..::.ObjectDisposedExceptionThe provided CancellationToken has already been disposed.

See Also

previous page start next page